Mosquitto Metrics Exporter

Premium

Pro Mosquitto provides a Prometheus exporter and a InfluxDB exporter which both expose the metrics available in the core broker and any metrics provided by other plugins.

Plugin configuration

Prometheus Metrics Exporter

To enable the Prometheus Metrics Exporter plugin it must be loaded into the broker with, by adding the following to your mosquitto.conf:

global_plugin /usr/lib/cedalo_metrics_prometheus.so

The plugin has some options which can be configured.

• bind_address : by default, the exporter will listen on all available network interfaces. You can bind it to a specific address using this option. For example, plugin_opt_bind_address 192.0.2.1
• port : by default, the exporter will listen on port 8000. You can use another port with this option. For example plugin_opt_port 8100
• update_interval : metrics stored in the exporter are updated on a set interval, by default 15 seconds. It is important to match this to the scrape interval of your Prometheus setup. If you are using a 60 second scrape interval, then use plugin_opt_update_interval 60

A sample configuration could look like:

global_plugin /usr/lib/cedalo_metrics_prometheus.so
plugin_opt_update_interval 60
plugin_opt_bind_address 192.0.2.1
plugin_opt_port 8100

InfluxDB Metrics Exporter

To enable the InfluxDB Metrics Exporter plugin it must be loaded into the broker with, by adding the following to your mosquitto.conf:

global_plugin /usr/lib/cedalo_metrics_influxdb.so

The plugin has some options which can be configured.

• hostname: The InfluxDB hostname to connect to. Required.

• port: The network port to use to connect to InfluxDB. Optional, defaults to 8086.

• username: The username to use when connecting to InfluxDB. Required.

• password: The password to use when connecting to InfluxDB (i.e., the authorization token for the specified user). Required.

• database: The InfluxDB database to send metrics to. Required.

• use_tls: Set to true/false to use TLS encrypted connections. It is recommended to always use encrypted connections. Optional, defaults to false.

• cafile: If you need to use a custom CA certificate for connecting to your InfluxDB instance, use this option to specify the file to use.

• hostlabel: By default, the plugin will attempt to read the hostname of the instance where it is running, and set the host tag label to that value. This option allows you to specify a different label.

• measurement: By default, the mosquitto measurement will be used for storing metrics. This option allows you to specify a different label.

• update_interval : metrics stored in the exporter are published on a set interval, by default 15 seconds.

• connect_timeout : Number of seconds to wait when connecting to InfluxDB, in case of failure. Optional, defaults to 10 seconds.

A sample configuration could look like:

global_plugin /usr/lib/cedalo_metrics_influxdb.so
plugin_opt_update_interval 60
plugin_opt_hostname influxdb.example.com
plugin_opt_port 8100
plugin_opt_hostlabel broker1
plugin_opt_database edge_data
plugin_opt_use_tls true
plugin_opt_username username
plugin_opt_password password

Optional configuration (applies to both exporters)

You may also consider turning off the $SYS updates from the broker:

sys_interval 0

Available metrics

label	metric type	description
mosq_broker_metric_sessions	Gauge	Current client sessions (includes offline clients)
mosq_broker_metric_clients_offline	Gauge	Current offline client count
mosq_broker_metric_clients_online	Gauge	Current online client count
mosq_broker_metric_clients_expired	Counter	Total clients expired due to keepalive
mosq_broker_metric_subscriptions	Gauge	Current subscription count
mosq_broker_metric_shared_subscriptions	Gauge	Current shared subscription count
mosq_broker_metric_retained_messages	Gauge	Current retained message count
mosq_broker_metric_bytes_received	Counter	Total bytes received
mosq_broker_metric_bytes_sent	Counter	Total bytes sent
mosq_broker_metric_pub_bytes_received	Counter	Total PUBLISH payload bytes received
mosq_broker_metric_pub_bytes_sent	Counter	Total PUBLISH payload bytes sent
mosq_broker_metric_message_store_count	Gauge	Current stored message count
mosq_broker_metric_message_store_bytes	Gauge	Current stored message bytes
mosq_broker_metric_out_packets	Gauge	Current queued outgoing packet count (includes offline clients)
mosq_broker_metric_out_packet_bytes	Gauge	Current queued outgoing packet bytes (includes offline clients)
mosq_broker_metric_socket_connections	Counter	Total incoming connections
mosq_broker_metric_mqtt_packets_received	Counter	Total MQTT packets received
mosq_broker_metric_mqtt_packets_sent	Counter	Total MQTT packets sent
mosq_broker_metric_mqtt_connect_received	Counter	MQTT CONNECT received
mosq_broker_metric_mqtt_connect_sent	Counter	MQTT CONNECT sent
mosq_broker_metric_mqtt_connack_received	Counter	MQTT CONNACK received
mosq_broker_metric_mqtt_connack_sent	Counter	MQTT CONNACK sent
mosq_broker_metric_mqtt_publish_dropped	Counter	MQTT PUBLISH dropped
mosq_broker_metric_mqtt_publish_received	Counter	MQTT PUBLISH received
mosq_broker_metric_mqtt_publish_sent	Counter	MQTT PUBLISH sent
mosq_broker_metric_mqtt_puback_received	Counter	MQTT PUBACK received
mosq_broker_metric_mqtt_puback_sent	Counter	MQTT PUBACK sent
mosq_broker_metric_mqtt_pubrec_received	Counter	MQTT PUBREC received
mosq_broker_metric_mqtt_pubrec_sent	Counter	MQTT PUBREC sent
mosq_broker_metric_mqtt_pubrel_received	Counter	MQTT PUBREL received
mosq_broker_metric_mqtt_pubrel_sent	Counter	MQTT PUBREL sent
mosq_broker_metric_mqtt_pubcomp_received	Counter	MQTT PUBCOMP received
mosq_broker_metric_mqtt_pubcomp_sent	Counter	MQTT PUBCOMP sent
mosq_broker_metric_mqtt_subscribe_received	Counter	MQTT SUBSCRIBE received
mosq_broker_metric_mqtt_subscribe_sent	Counter	MQTT SUBSCRIBE sent
mosq_broker_metric_mqtt_suback_received	Counter	MQTT SUBACK received
mosq_broker_metric_mqtt_suback_sent	Counter	MQTT SUBACK sent
mosq_broker_metric_mqtt_unsubscribe_received	Counter	MQTT UNSUBSCRIBE received
mosq_broker_metric_mqtt_unsubscribe_sent	Counter	MQTT UNSUBSCRIBE sent
mosq_broker_metric_mqtt_unsuback_received	Counter	MQTT UNSUBACK received
mosq_broker_metric_mqtt_unsuback_sent	Counter	MQTT UNSUBACK sent
mosq_broker_metric_mqtt_pingreq_received	Counter	MQTT PINGREQ received
mosq_broker_metric_mqtt_pingreq_sent	Counter	MQTT PINGREQ sent
mosq_broker_metric_mqtt_pingresp_received	Counter	MQTT PINGRESP received
mosq_broker_metric_mqtt_pingresp_sent	Counter	MQTT PINGRESP sent
mosq_broker_metric_mqtt_disconnect_received	Counter	MQTT DISCONNECT received
mosq_broker_metric_mqtt_disconnect_sent	Counter	MQTT DISCONNECT sent
mosq_broker_metric_mqtt_auth_received	Counter	MQTT AUTH received
mosq_broker_metric_mqtt_auth_sent	Counter	MQTT AUTH sent
mosq_broker_metric_basic_auth_success	Counter	Successful username/password authentication attempts
mosq_broker_metric_basic_auth_fail	Counter	Failed username/password authentication attempts
mosq_broker_metric_basic_auth_error	Counter	Errored username/password authentication attempts
mosq_broker_metric_extended_auth_success	Counter	Successful extended authentication attempts
mosq_broker_metric_extended_auth_fail	Counter	Failed extended authentication attempts
mosq_broker_metric_extended_auth_error	Counter	Errored extended authentication attempts